Options
All
  • Public
  • Public/Protected
  • All
Menu

Swarm messages channels list

export
template
template
template
template
template
template
template
template
template

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected Optional __swarmChannelsFabricChannelDescription

__swarmChannelsFabricChannelDescription: ISwarmMessagesChannelFabricByChannelDescriptionWithDefaults<OrbitDB, T, MD, DbType, DBO, undefined, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreOptionsConnectorFabric<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>>, TSwarmMessagesStoreGrantAccessCallback<OrbitDB, MD | T, Record<string, unknown>>, undefined, ISwarmMessageStoreOptionsWithConnectorFabric<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreOptionsConnectorFabric<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>>, MD | T, TSwarmMessagesStoreGrantAccessCallback<OrbitDB, MD | T, Record<string, unknown>>, undefined, undefined>, ISwarmMessageStore<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreOptionsConnectorFabric<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>>, MD | T, TSwarmMessagesStoreGrantAccessCallback<OrbitDB, MD | T, Record<string, unknown>>, undefined, undefined, ISwarmMessageStoreOptionsWithConnectorFabric<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreOptionsConnectorFabric<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>, ISwarmStoreProviderOptions<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>, ISwarmStoreConnector<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>, ISwarmStoreConnectorOrbitDBConnectionOptions<T, DbType, DBO, ISwarmStoreConnectorBasic<OrbitDB, T, DbType, DBO>>>>, MD | T, TSwarmMessagesStoreGrantAccessCallback<OrbitDB, MD | T, Record<string, unknown>>, undefined, undefined>>, ISwarmMessageChannelDescriptionRaw<OrbitDB, T, DbType, DBO>>

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

Readonly props

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: { connectionBridge: undefined | IConnectionBridge<OrbitDB, T, DbType, DBO, ISwarmStoreConnectorBasic<any, any, any, any>, ISwarmStoreConnectorOrbitDBConnectionOptions<any, any, any, any>, ISwarmStoreProviderOptions<any, any, any, any, any, any>, ISwarmMessageStore<any, any, any, any, any, any, any, any, any, any, any, any, any, any>, ISwarmStoreOptionsConnectorFabric<any, any, any, any, any, any, any, any>, any, MD | T, ISwarmMessageStoreAccessControlGrantAccessCallback<any, any, Record<string, unknown>> & { toString: any }, ISwarmMessageConstructorWithEncryptedCacheFabric, ISwarmMessageStoreAccessControlOptions<any, any, any, any>, any, CD, any, any, any, CBO["serializer"]>; databaseOpeningStatus: boolean; databasesList: undefined | ISwarmStoreDatabasesCommonStatusList<OrbitDB, T, DbType, DBO>; dbRemoved: boolean; dbRemoving: boolean; error: undefined | Error; isConnecting: boolean; isDatabaseListVisible: boolean; messages: any[]; messagesReceived: Map<string, Map<string, IMessageDescription<OrbitDB>>>; messagingSending: undefined | Timeout; secretStorage: undefined | ISecretStorage; swarmStoreMessagesDbOptionsList: DBO[]; userCredentialsActive: undefined | IUserCredentialsCommon; userId: undefined | string; userProfileData: undefined | Partial<ICentralAuthorityUserProfile> } = ...

Type declaration

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

Protected defaultDbOptions

  • get defaultDbOptions(): DBO
  • Returns DBO

Protected mainDatabaseName

  • get mainDatabaseName(): string
  • Returns string

Protected mainDatabaseOptions

  • get mainDatabaseOptions(): DBO
  • Returns DBO

Protected swarmMessageStore

  • get swarmMessageStore(): any
  • Returns any

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

Private __createSwarmChannelsFabricChannelDescription

Protected __getExistingSwarmChannelsFabricChannelDescriptionOrCreateNewOne

Private __handleChannelClosed

  • __handleChannelClosed(): void
  • Returns void

Private __handleChannelsListIsReady

  • __handleChannelsListIsReady(): Promise<void>
  • Returns Promise<void>

Private __onChoseSwarmChannel

  • Parameters

    Returns Promise<void>

Protected _connectToSwarmAndCreateSwarmMessagesChannelsList

Protected _createSwarmChannelInstanceByDescription

  • Parameters

    Returns Promise<void>

Protected _createSwarmMessagesChannelsList

Protected _getConnectionBridgeInstance

Protected _getDatabaseConnectorFabricForChannnelsList

Protected _getOptionsForConstructorArgumentsFabric

  • Returns Pick<ISwarmMessagesChannelsDescriptionsListConstructorArguments<any, any, any, any, any, any>, "description" | "connectionOptions"> & { utilities: { serializer: ISerializer<any> }; validators: { jsonSchemaValidator: (jsonSchema: JSONSchema7, valueToValidate: any) => Promise<void> } }

Protected _getOptionsForSwarmMessagesChannelV1FabricByChannelsListInstanceAndChannelDescription

Protected _getOptionsForSwarmMessagesDatabaseConnectedWithoutDatabaseOptionsFabric

  • _getOptionsForSwarmMessagesDatabaseConnectedWithoutDatabaseOptionsFabric(): Omit<ISwarmMessagesDatabaseConnectOptions<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>, "dbOptions">

Protected _getSwarmMessagesChannelConstructorOptions

Protected _getSwarmMessagesDatabaseConnectorOptions

  • Returns Omit<ISwarmMessagesDatabaseConnectOptions<OrbitDB, T, DbType, DBO, any, any, any, any, any, any, any, any, any, any, MD, any, any, any>, "user" | "dbOptions">

Protected _onChannelAdded

Protected _renderSwarmMessagesChannel

  • _renderSwarmMessagesChannel(): ReactElement<any, string | JSXElementConstructor<any>>
  • Returns ReactElement<any, string | JSXElementConstructor<any>>

Protected _renderUserIdentity

  • _renderUserIdentity(): null | ReactElement<any, string | JSXElementConstructor<any>>
  • Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Protected _setListenersChannelsListInstance

  • Parameters

    Returns void

Protected addChannelDescriptionToChannelsList

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): Promise<void>

Optional componentDidUpdate

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

connectToDb

  • connectToDb(): Promise<void>

Protected connectToSwarm

Protected createDatabaseConnector

forceUpdate

  • forceUpdate(callBack?: () => void): void

Protected getCurrentUserId

  • getCurrentUserId(): string
  • Returns string

Protected getOptionsForSwarmMessagesDatabaseConnectedFabric

  • getOptionsForSwarmMessagesDatabaseConnectedFabric(dbsOptions: DBO): ISwarmMessagesDatabaseConnectOptions<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

Optional getSnapshotBeforeUpdate

Protected getSwarmMessagesChannelDescriptionDefault

Protected getSwarmMessagesCollector

handleClickOpenNewSwarmStoreMessagesDatabase

  • handleClickOpenNewSwarmStoreMessagesDatabase(): Promise<void>

handleDatabaseRemove

  • handleDatabaseRemove(): Promise<void>

Protected handleDatabasesListUpdate

Protected handleMessage

  • handleMessage(dbName: DBO["dbName"], message: MI, id: string, key: string): void

handleOpenDatabase

  • handleOpenDatabase(dbName?: string): Promise<void>

handleOpenNewDatabase

  • handleOpenNewDatabase(): Promise<void>

Protected handleOpenNewSwarmStoreMessagesDatabase

  • handleOpenNewSwarmStoreMessagesDatabase(dbOptionsToConnectImmediate?: Partial<DBO>): Promise<void>

Protected isConnectionBridgeInstanceInitialized

  • isConnectionBridgeInstanceInitialized(): boolean
  • Returns boolean

loadNextMessages

  • loadNextMessages(): Promise<void>

render

  • render(): ReactElement<any, string | JSXElementConstructor<any>>
  • Returns ReactElement<any, string | JSXElementConstructor<any>>

Protected renderConnectToDatabase

  • renderConnectToDatabase(): Element

renderConnectedState

  • renderConnectedState(): Element

Protected renderDatabasesList

  • renderDatabasesList(): Element

renderLoadMessages

  • renderLoadMessages(): Element

Protected renderSwarmMessagesDatabasesList

  • renderSwarmMessagesDatabasesList(): Element

Protected renderUserProfile

  • renderUserProfile(): Element

Protected sendPrivateSwarmMessage

  • sendPrivateSwarmMessage(): Promise<void>

Protected sendSwarmMessage

  • sendSwarmMessage(): Promise<never>

Protected setListenersConnectionBridge

setState

Optional shouldComponentUpdate

Protected toggleDatabasesListVisible

  • toggleDatabasesListVisible(): void

Protected toggleMessagesSending

  • toggleMessagesSending(isPrivate?: boolean): void

Generated using TypeDoc